home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / DoWhenIdle.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  6.7 KB  |  263 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/DoWhenIdle.man,v 1.6 91/12/06 10:38:59 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tk_DoWhenIdle tk
  189. .BS
  190. .SH NAME
  191. Tk_DoWhenIdle, Tk_CancelIdleCall \- invoke a procedure when there are no pending events
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tk.h>\fR
  195. .sp
  196. \fBTk_DoWhenIdle\fR(\fIproc, clientData\fR)
  197. .sp
  198. .VS
  199. \fBTk_CancelIdleCall\fR(\fIproc, clientData\fR)
  200. .VE
  201. .SH ARGUMENTS
  202. .AS Tk_IdleProc clientData
  203. .AP Tk_IdleProc *proc in
  204. Procedure to invoke.
  205. .AP ClientData clientData in
  206. Arbitrary one-word value to pass to \fIproc\fR.
  207. .BE
  208.  
  209. .SH DESCRIPTION
  210. .PP
  211. \fBTk_DoWhenIdle\fR arranges for \fIproc\fR to be invoked
  212. when the application becomes idle.  The application is
  213. considered to be idle when \fBTk_DoOneEvent\fR has been
  214. called, it couldn't find any events to handle, and it is about
  215. to go to sleep waiting for an event to occur.  At this
  216. point all pending \fBTk_DoWhenIdle\fR handlers are
  217. invoked.  For each call to \fBTk_DoWhenIdle\fR there will
  218. be a single call to \fIproc\fR;  after \fIproc\fR is
  219. invoked the handler is automatically removed.
  220. \fBTk_DoWhenIdle\fR is only useable in programs that
  221. use \fBTk_DoOneEvent\fR to dispatch events.
  222. .PP
  223. \fIProc\fP should have arguments and result that match the
  224. type \fBTk_IdleProc\fR:
  225. .nf
  226. .RS
  227. typedef void Tk_IdleProc(ClientData \fIclientData\fR);
  228. .RE
  229. .fi
  230. The \fIclientData\fP parameter to \fIproc\fR is a copy of the \fIclientData\fP
  231. argument given to \fBTk_DoWhenIdle\fR.  Typically, \fIclientData\fR
  232. points to a data structure containing application-specific information about
  233. what \fIproc\fR should do.
  234. .PP
  235. \fBTk_CancelIdleCall\fR
  236. .VS
  237. may be used to cancel one or more previous
  238. calls to \fBTk_DoWhenIdle\fR:  if there is a \fBTk_DoWhenIdle\fR
  239. handler registered for \fIproc\fR and \fIclientData\fR, then it
  240. is removed without invoking it.  If there is more than one
  241. handler on the idle list that refers to \fIproc\fR and \fIclientData\fR,
  242. all of the handlers are removed.  If no existing handlers match
  243. \fIproc\fR and \fIclientData\fR then nothing happens.
  244. .VE
  245. .PP
  246. \fBTk_DoWhenIdle\fR is most useful in situations where
  247. (a) a piece of work will have to be done but (b) it's
  248. possible that something will happen in the near future
  249. that will change what has to be done, or require something
  250. different to be done.  \fBTk_DoWhenIdle\fR allows the
  251. actual work to be deferred until all pending events have
  252. been processed.  At this point the exact work to be done
  253. will presumably be known and it can be done exactly once.
  254. .PP
  255. For example, \fBTk_DoWhenIdle\fR might be used by an editor
  256. to defer display updates until all pending commands have
  257. been processed.  Without this feature, redundant redisplays
  258. might occur in some situations, such as the processing of
  259. a command file.
  260.  
  261. .SH KEYWORDS
  262. callback, defer, handler, idle
  263.